Configuring: Proficy Historian Alarm and Event Source

Requirements

This operation requires the installation of the Proficy Historian Client SDK on the CSense machine. This operation uses the Proficy Historian OLE DB Provider provided by installing the Proficy Historian Client SDK.

Worked example: Proficy Historian Alarm and Event Source

Steps to configure

Connection: Connect to the server, logging in with your username and password. Check the connection.
Time window: Define the time window of Alarms and Events data required.
Field selection: Select the fields to import.
Filter: Define one or more filters that applies to the data of that chosen field that is retrieved (Optional).
Execution: On execute, the import of the fields will be seen, and the new dataset will populate the workspace.

Step 1: Connection

Connect to the server, in order to receive data from the Proficy Historian. Log in with your username and password.

Leaving the server text box empty implies connecting to the default server.
Click [Next] to check the connection.
If you type in incorrect server and user details, the connection will fail. This will be displayed on the next configuration page. You then have the opportunity to return to this page, and correct the details.
Default: All connection detail text boxes are blank.
Minimum configuration: None

Checking the connection:

This page is automatically skipped if the connection is successful.
If the connection failed:
- An error message is displayed. Click [Details] for more information on the connection error.
- Check your connection details entered on the connection page.
- From this page, it is only possible to return to the connection page.

Step 2: Time window

Define the time window of Alarms and Events data retrieval required.

Define a data window, specifying either a start and end, start and duration or end and duration of the window.
The dates and times need to be valid dates and times. Use either the date/time picker or edit the values manually. The duration must be in the form d h:mm:ss.
The window must have a positive duration, i.e. >0 seconds.
It is possible to execute the operation at this point, after specifying the data windows.
Default: Data window selected, with Start + End selected where the end date and time is the current time and a duration of 24 hours.
Minimum configuration: A data window must be defined with a positive duration.

Step 3: Field selection

Select the fields to import. Use the [>] and [<] to move fields between the available fields pane and the selected fields pane.

The list of fields are retrieved from the Proficy Historian based on the Time Window configured in the previous step.
If the Proficy Historian does not contain any Alarms and Events data for configured time, some fields might not be listed. This is specifically relevant for the User-Defined variables. In this case at least the documented fields will be listed.

NOTE: If the Proficy Historian does not contain any Alarms and Events data for configured time, the operation might not be able to retrieve User-Defined variables for possible selection.

It is possible to execute the operation at this point, after selecting fields.
Default: All available fields will be selected.
Minimum configuration: At least one field must be selected.

Step 4: Filters

Define filters that apply to the Alarms and Events data that is retrieved.

Filters are added and configured by editing the filters directly in the provided table.
Click on the row in the table where it states that a new row can be added.
Edit the cells in the table to configure the filter.
Right click on a filter in the table and select the "Delete Row" option to delete a filter.
For example: configuring the filter as follows:
- Field: Field1
- Comparison: Equal
- Value: 2
- means that only rows where the value of Field1 is 2 will be imported into the new dataset.
Specify how the configured filters must be applied:
- Using the "Match Filters" option, select either "All", "Any" or "Custom"
- If "All" is specified only Alarms and Events data that satisfies all of the configured filters will be retrieved from the Proficy Historian.
- If "Any" is specified all Alarms and Events data that satisfies one or more of the configured filters will be retrieved from the Proficy Historian.
- If "Custom" is specified a custom filter must be provided using a filter expression:
- - Example filter expression: (1 AND 2) AND NOT 3
  - The following operators are allowed: AND, OR and NOT
  - Parenthesis are allowed to specify complex expressions.
  - Numbers are used to refer to filters numbers configured in the filters table.
  - The expression syntax is checked and feedback is provided as the filter created.
    
    NOTE: An expression that has validation errors can still be accepted by the operation but might result in errors when trying to read Alarms and Events data from the Proficy Historian.
    
    NOTE: The following validation errors will prevent the operation to be executed: Invalid characters or words, unmatched parenthesis and incorrect filter numbers.
Default: No filters are configured and the match filters option is set to match all filters.
Minimum configuration: No filters configured.

Step 5: Execute

On execute, the import of the fields will be seen, and the new dataset will populate the workspace. The data will be called from the Proficy Historian Alarms and Events source, and the new dataset will show the selected fields with filtered data (if filters were configured.)